Skip to content

docs: improve toolkit package README with full API reference#93

Merged
sepehr-safari merged 1 commit into
mainfrom
docs/toolkit-readme
Jul 8, 2026
Merged

docs: improve toolkit package README with full API reference#93
sepehr-safari merged 1 commit into
mainfrom
docs/toolkit-readme

Conversation

@sepehr-safari

Copy link
Copy Markdown
Member

Summary

Rewrites the packages/toolkit/README.md from a bare 35-line stub to a comprehensive package README with:

  • Full feature list (10 detection rules, replay engine, React components, etc.)
  • Complete subpath exports table with browser-safe annotations
  • Programmatic usage examples for every subpath (core, scenarios, reporter, replay, react, fixtures)
  • CLI command reference with all commands and options
  • Trace format documentation with wire format examples
  • Links to docs, migration guide, and issue tracker

The README is displayed on the npm package page (npmjs.com/package/@ocpp-debugkit/toolkit) and is included in the published tarball (verified with npm pack --dry-run).

Closes #82

Checklist

  • packages/toolkit/README.md rewritten with all sections
  • All code examples use correct, current API signatures (verified against src/)
  • Subpath exports table matches actual package.json#exports
  • CLI commands match actual src/cli/index.ts command definitions
  • npm pack --dry-run confirms README is included in tarball
  • Format check passes
  • No changeset needed (docs-only, no package behavior change)

@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ocpp-debugkit-web Ready Ready Preview, Comment Jul 8, 2026 11:45pm

@sepehr-safari sepehr-safari merged commit 1fa27e4 into main Jul 8, 2026
4 checks passed
@sepehr-safari sepehr-safari deleted the docs/toolkit-readme branch July 8, 2026 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: improve toolkit package README

1 participant